home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / kgdb / RCS / kgdb.man,v < prev   
Encoding:
Text File  |  1990-10-18  |  5.5 KB  |  183 lines
  1. head     1.3;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.3
  10. date     90.10.18.12.21.03;  author kupfer;  state Exp;
  11. branches ;
  12. next     1.2;
  13.  
  14. 1.2
  15. date     90.05.03.14.43.59;  author mendel;  state Exp;
  16. branches ;
  17. next     1.1;
  18.  
  19. 1.1
  20. date     89.01.24.16.39.13;  author mendel;  state Exp;
  21. branches ;
  22. next     ;
  23.  
  24.  
  25. desc
  26. @Man page for kgdb.
  27. @
  28.  
  29.  
  30. 1.3
  31. log
  32. @Minor grammatical fixes.
  33. @
  34. text
  35. @' Copyright 1989 Regents of the University of California
  36. ' Permission to use, copy, modify, and distribute this
  37. ' documentation for any purpose and without fee is hereby
  38. ' granted, provided that this notice appears in all copies.
  39. ' The University of California makes no representations about
  40. ' the suitability of this material for any purpose.  It is
  41. ' provided "as is" without express or implied warranty.
  42. ' 
  43. ' $Header: /sprite/src/cmds/kgdb/RCS/kgdb.man,v 1.2 90/05/03 14:43:59 mendel Exp Locker: kupfer $ SPRITE (Berkeley)
  44. ' 
  45. .so \*(]ltmac.sprite
  46. .HS KGDB cmds
  47. .BS
  48. .SH NAME
  49. kgdb \- A kernel debugger based on GDB
  50. .SH SYNOPSIS
  51. .nf
  52. \fBkgdb\fR [\fI-mtm\fR]\ [\fIgdb options\fR] [\fIkernel\fR]
  53. .SH OPTIONS
  54. .IP "\fB\-mtm\fR" 14
  55. Invoke the debugger for the target machine given by tm.  If specified, this
  56. option must proceed all other options. The list of available target machines
  57. include sun2, sun3, sun4, and spur.
  58. .LP
  59. See the GNU GDB documentation for information about the rest of the available
  60. options.
  61. .BE
  62.  
  63. .SH DESCRIPTION
  64. .PP
  65. \fBKgdb\fR is a version of the GNU gdb debugger modified to debug Sprite
  66. kernels.
  67. This manual page only describes the parts of \fBkgdb\fR that differ 
  68. from \fBgdb\fR.  
  69. The reader is referred to the GNU GDB documentation and gdb manual page for a
  70. complete description of \fBgdb\fR.
  71. .SH "DIFFERENCES FROM GDB"
  72. .LP
  73. The "attach" and "detach" commands of \fBkgdb\fR differ from those of 
  74. \fBgdb\fR.  
  75. .IP "\fBattach\fR machine"
  76. The attach command of \fBkgdb\fR takes as an argument the hostname or 
  77. internet address of a Sprite machine to debug.  
  78. The command assumes that the specified machine is in the kernel 
  79. debugging stub and will wait for the machine to
  80. enter the debugger.  Once the connection to the machine is 
  81. established,
  82. the trap condition and any unprinted syslog messages are displayed.
  83. .IP "\fBdetach\fR [cont]"
  84. The detach command breaks the connection between \fBkgdb\fR and the
  85. currently attached machine.  If any argument is specified, the machine
  86. is continued before the connection is detached.  When used with the 
  87. "attach" command, the "detach" command allows debugging multiple machines 
  88. from the same \fBkgdb\fR session.
  89. .SH "ADDITIONS TO GDB"
  90. \fBKgdb\fR supports several commands not found in \fBgdb\fR.  The commands
  91. are:
  92. .IP "\fBpid\fR proc-id"
  93. The pid command sets the focus of the debugger on the  process whose
  94. process id is proc-id. 
  95. Once a process is choosen with the pid command,
  96. all stack reference commands such as "backtrace" and "frame" will reference
  97. this process's stack.  For example, the command "pid 0xa1139" followed
  98. by the "backtrace" command will display a stack backtrace of the process
  99. with pid of 0xa1139. Note that proc-id can be any expression supported by
  100. \fBkgdb\fR.
  101. .IP "\fBreboot\fR [string]"
  102. The reboot command reboots the current attached machine. The optional
  103. argument string is passed to the kernel routine Mach_MonReboot.  Note 
  104. that this command is the same as typing "print Mach_MonReboot(string)" followed
  105. by a break and a detach command except that the reboot command will work 
  106. even if no symbol table is loaded.
  107. .IP "\fBversion\fR"
  108. The version command prints the kernel version string of the 
  109. attached machine. This command outputs the same information as the
  110. command "print SpriteVersion()" but like the "reboot" command doesn't
  111. require a symbol table to be loaded.
  112. .IP "\fBdebug\fR hostname"
  113. The debug command is similar to the attach command differing only
  114. in the case when the specified machine is not already in the debugging stub.  
  115. Rather than waiting
  116. for the machine to enter the debugger like the attach command, the
  117. debug command will force the machine into the debugger using 
  118. the \fBkmsg\fR program. 
  119. In order for this command to work, 
  120. the \fBkmsg\fR program must be available in the current
  121. search path of \fBkgdb\fR. Because of its anti-social possiblities, 
  122. caution is urged in the use of the debug command.
  123. .SH "DELETIONS FROM GDB"
  124. .LP
  125. Several features of \fBgdb\fR are not available in \fBkgdb\fR because 
  126. they don't apply to kernel debugging.
  127. Missing features include the ability to start and kill programs with the 
  128. "run"
  129. and "kill" commands; to change the program's environment and
  130. terminal characteristics with the
  131. "set-env", "unset-env", "set-args", and "tty" commands;  
  132. and  to handle signals with
  133. "handle" and "signal" commands.  
  134. Additionaly, \fBgdb\fR's core file processing such as the 
  135. .B core
  136. command are also 
  137. not available in \fBkgdb\fR.
  138.  
  139. .SH KEYWORDS
  140. gdb, kernel, debugging, kmsg
  141. @
  142.  
  143.  
  144. 1.2
  145. log
  146. @*** empty log message ***
  147. @
  148. text
  149. @d9 1
  150. a9 1
  151. ' $Header: /sprite/src/cmds/kgdb/RCS/kgdb.man,v 1.1 89/01/24 16:39:13 mendel Exp Locker: mendel $ SPRITE (Berkeley)
  152. d12 1
  153. a12 1
  154. .HS <KGDB> cmds
  155. d25 1
  156. a25 1
  157. See the GNU GDB documentation for information about rest of the available
  158. d43 2
  159. a44 2
  160. internet address of Sprite machine to debug.  
  161. The commands assumes that the specified machine is in the kernel 
  162. d47 1
  163. a47 1
  164. successful established,
  165. d100 3
  166. a102 1
  167. Additionaly, \fBgdb\fR's core file processing such as "core" command are also 
  168. @
  169.  
  170.  
  171. 1.1
  172. log
  173. @Initial revision
  174. @
  175. text
  176. @d9 1
  177. a9 1
  178. ' $Header: /sprite/lib/forms/RCS/proto.man,v 1.3 89/01/09 11:43:01 ouster Exp $ SPRITE (Berkeley)
  179. d92 1
  180. a92 1
  181. either they don't apply to kernel debugging.
  182. @
  183.